<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class User</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class User</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
		<p class="notes">
			Located in <a class="field" href="_includes_user_functions_user_php.html">/includes/user_functions/user.php</a> (line <span class="field">28</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$result" title="details" class="var-name">$result</a>
				</div>
							</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
								
				<div class="method-definition">
											<span class="method-result"><a href="../default/User.html">User</a></span>
										<a href="#User" title="details" class="method-name">User</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#Authenticate" title="details" class="method-name">Authenticate</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, <span class="var-type">adodb</span>&nbsp;<span class="var-name">$database_connection</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">adodb</span>
										<a href="#IdToUsername" title="details" class="method-name">IdToUsername</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$userId</span>, <span class="var-type">adodb</span>&nbsp;<span class="var-name">$database_connection</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#RegisterUser" title="details" class="method-name">RegisterUser</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$firstname</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$lastname</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$retype_passwd</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$email</span>, <span class="var-type">adodb</span>&nbsp;<span class="var-name">$database_connection</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">adodb</span>
										<a href="#UsernameToId" title="details" class="method-name">UsernameToId</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">adodb</span>&nbsp;<span class="var-name">$database_connection</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#UserUpdateLastseen" title="details" class="method-name">UserUpdateLastseen</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">adodb</span>&nbsp;<span class="var-name">$database_connection</span>)
									</div>
							</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$result" id="$result"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$result</span>
						(line <span class="line-number">37</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodUser" id="User"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor User</span> (line <span class="line-number">45</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Default constructor for user class. Sets $userId,$userName,$password,$emailAddress  $lastLogin,$database_connection all to null</p>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/User.html">User</a></span>
		<span class="method-name">
			User
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodAuthenticate" id="Authenticate"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Authenticate</span> (line <span class="line-number">64</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check if user is a valid user.</p>
	<ul class="tags">
				<li><span class="field">return:</span> empty - user did not fill in form || badusername - user enters || badpassword - user enters invalid password || valid - user has entered valid password and username</li>
				<li><span class="field">author:</span> Demetrios Dimatos</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			Authenticate
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, <span class="var-type">adodb</span>&nbsp;<span class="var-name">$database_connection</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span><span class="var-description">: - username for database connecion</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$password</span><span class="var-description">: - password for username to database</span>			</li>
					<li>
				<span class="var-type">adodb</span>
				<span class="var-name">$database_connection</span><span class="var-description">: connection $database_connection - adodb connection from a database</span>			</li>
				</ul>
		
		
	</div>
<a name="methodIdToUsername" id="IdToUsername"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">IdToUsername</span> (line <span class="line-number">177</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Convert user id to username</p>
	<ul class="tags">
				<li><span class="field">return:</span> resultset object - user name</li>
				<li><span class="field">author:</span> Demetrios Dimatos</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">adodb</span>
		<span class="method-name">
			IdToUsername
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$userId</span>, <span class="var-type">adodb</span>&nbsp;<span class="var-name">$database_connection</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span>			</li>
					<li>
				<span class="var-type">adodb</span>
				<span class="var-name">$database_connection</span><span class="var-description">: connection $database_connection - adodb connection to a database</span>			</li>
				</ul>
		
		
	</div>
<a name="methodRegisterUser" id="RegisterUser"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">RegisterUser</span> (line <span class="line-number">209</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds a new user to GDE</p>
	<ul class="tags">
				<li><span class="field">return:</span> empty - when one of the fields is not filled out || missmatch    - passwords did not match || duplicate    - insert fails on duplicate key usernames || valid    - when user is registered successfully ||valid    - when user is registered successfully</li>
				<li><span class="field">author:</span> Demetrios Dimatos</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			RegisterUser
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$firstname</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$lastname</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$retype_passwd</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$email</span>, <span class="var-type">adodb</span>&nbsp;<span class="var-name">$database_connection</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$firstname</span><span class="var-description">: - users fist name</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$lastname</span><span class="var-description">: - users last name</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span><span class="var-description">: - desired username</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$password</span><span class="var-description">: - password</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$retype_passwd</span><span class="var-description">: - retyped password</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$email</span><span class="var-description">: - users email</span>			</li>
					<li>
				<span class="var-type">adodb</span>
				<span class="var-name">$database_connection</span><span class="var-description">: connection $database_connection - adodb connection to a database</span>			</li>
				</ul>
		
		
	</div>
<a name="methodUsernameToId" id="UsernameToId"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">UsernameToId</span> (line <span class="line-number">150</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Convert username to user id</p>
	<ul class="tags">
				<li><span class="field">return:</span> resultset object - user id</li>
				<li><span class="field">author:</span> Demetrios Dimatos</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">adodb</span>
		<span class="method-name">
			UsernameToId
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">adodb</span>&nbsp;<span class="var-name">$database_connection</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span>			</li>
					<li>
				<span class="var-type">adodb</span>
				<span class="var-name">$database_connection</span><span class="var-description">: connection $database_connection - adodb connection to a database</span>			</li>
				</ul>
		
		
	</div>
<a name="methodUserUpdateLastseen" id="UserUpdateLastseen"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">UserUpdateLastseen</span> (line <span class="line-number">127</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Inserts the date the user was last seen</p>
	<ul class="tags">
				<li><span class="field">return:</span> true/false - for success if user is updated</li>
				<li><span class="field">author:</span> Demetrios Dimatos</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			UserUpdateLastseen
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">adodb</span>&nbsp;<span class="var-name">$database_connection</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span><span class="var-description">: - GDE logged/valid user</span>			</li>
					<li>
				<span class="var-type">adodb</span>
				<span class="var-name">$database_connection</span><span class="var-description">: connection $database_connection - adodb connection to a database</span>			</li>
				</ul>
		
		
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 20 Oct 2006 00:33:15 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</div></body>
</html>